تقنيات إعادة هيكلة شيفرة بايثون: دليل شامل لتحسين جودة الشيفرة

في عالم تطوير البرمجيات دائم التطور، يعد الحفاظ على شيفرة نظيفة وفعالة ومفهومة أمرًا بالغ الأهمية. بايثون، المعروفة بقابليتها للقراءة، يمكن أن تقع فريسة لروائح الشيفرة (code smells) والدين التقني إذا لم تتم إدارتها بعناية. إعادة الهيكلة هي عملية إعادة بناء شيفرة الحاسوب الحالية — تغيير طريقة بنائها — دون تغيير سلوكها الخارجي. في جوهرها، هي عملية تنظيف لشيفرتك دون تعطيلها. يستكشف هذا الدليل مختلف تقنيات إعادة هيكلة شيفرة بايثون، ويقدم أمثلة عملية وأفضل الممارسات للارتقاء بجودة شيفرتك.

لماذا نعيد هيكلة شيفرة بايثون؟

تقدم إعادة الهيكلة فوائد عديدة، منها:

• تحسين القابلية للقراءة: يجعل الشيفرة أسهل للفهم والصيانة.
• تقليل التعقيد: يبسط المنطق المعقد، مما يقلل من احتمالية حدوث الأخطاء.
• تعزيز قابلية الصيانة: يسهل تعديل الشيفرة وتوسيعها.
• زيادة الأداء: يمكن أن يحسن الشيفرة لسرعة تنفيذ أفضل.
• خفض الدين التقني: يمنع تراكم الشيفرة التي يصعب صيانتها أو توسيعها.
• تصميم أفضل: يؤدي إلى بنية شيفرة أكثر قوة ومرونة.

يمكن أن يؤدي تجاهل إعادة الهيكلة إلى شيفرة يصعب فهمها وتعديلها واختبارها. وهذا يمكن أن يزيد بشكل كبير من وقت التطوير ومخاطر إدخال الأخطاء.

متى يجب إعادة الهيكلة؟

معرفة وقت إعادة الهيكلة أمر بالغ الأهمية. إليك بعض السيناريوهات الشائعة:

• قبل إضافة ميزات جديدة: يمكن أن تسهل إعادة هيكلة الشيفرة الحالية دمج وظائف جديدة.
• بعد إصلاح خطأ: يمكن أن تمنع إعادة هيكلة الشيفرة المحيطة تكرار أخطاء مماثلة.
• أثناء مراجعات الشيفرة: تحديد المجالات التي يمكن تحسينها وإعادة هيكلتها.
• عندما تواجه "روائح الشيفرة": روائح الشيفرة هي مؤشرات لمشاكل محتملة في شيفرتك.
• إعادة الهيكلة المجدولة بانتظام: دمج إعادة الهيكلة في عملية التطوير كنشاط منتظم.

تحديد روائح الشيفرة

روائح الشيفرة هي مؤشرات سطحية تتوافق عادةً مع مشكلة أعمق في النظام. لا تشير دائمًا إلى وجود مشكلة، ولكنها غالبًا ما تستدعي مزيدًا من التحقيق.

روائح الشيفرة الشائعة في بايثون:

• الشيفرة المكررة: شيفرة متطابقة أو متشابهة جدًا تظهر في أماكن متعددة.
• الدالة/الطريقة الطويلة: الدوال أو الطرق الطويلة والمعقدة بشكل مفرط.
• الفئة الكبيرة: الفئات التي لديها مسؤوليات كثيرة جدًا.
• قائمة المعلمات الطويلة: الدوال أو الطرق التي تحتوي على عدد كبير جدًا من المعلمات.
• تكتلات البيانات: مجموعات من البيانات التي تظهر معًا بشكل متكرر.
• الهوس بالأنواع الأولية: استخدام أنواع البيانات الأولية بدلاً من إنشاء كائنات.
• جمل التبديل (Switch): سلاسل طويلة من جمل if/elif/else أو جمل switch.
• الجراحة المتفرقة (Shotgun Surgery): إجراء تغيير واحد يتطلب إجراء العديد من التغييرات الصغيرة على فئات مختلفة.
• التغيير المتباعد (Divergent Change): يتم تغيير فئة بشكل شائع بطرق مختلفة لأسباب مختلفة.
• حسد الميزات (Feature Envy): تصل طريقة ما إلى بيانات كائن آخر أكثر من بياناتها الخاصة.
• سلاسل الرسائل (Message Chains): يطلب العميل من كائن أن يطلب من كائن آخر أن يطلب من كائن آخر...

تقنيات إعادة هيكلة شيفرة بايثون: دليل عملي

يفصل هذا القسم العديد من تقنيات إعادة هيكلة بايثون الشائعة مع أمثلة عملية.

1. استخراج طريقة/دالة (Extract Method/Function)

تتضمن هذه التقنية أخذ كتلة من الشيفرة داخل طريقة أو دالة ونقلها إلى طريقة أو دالة جديدة منفصلة. هذا يقلل من تعقيد الطريقة الأصلية ويجعل الشيفرة المستخرجة قابلة لإعادة الاستخدام.

مثال:

            
def print_invoice(customer, details):
    print("***********************")
    print(f"Customer: {customer}")
    print("***********************")

    total_amount = 0
    for order in details["orders"]:
        total_amount += order["amount"]

    print(f"Amount is : {total_amount}")

    if total_amount > 1000:
        print("You earned a discount!")

            

              
                Copy
              
            
          

بعد إعادة الهيكلة:

            
def print_header(customer):
    print("***********************")
    print(f"Customer: {customer}")
    print("***********************")


def calculate_total(details):
    total_amount = 0
    for order in details["orders"]:
        total_amount += order["amount"]
    return total_amount


def print_invoice(customer, details):
    print_header(customer)
    total_amount = calculate_total(details)
    print(f"Amount is : {total_amount}")

    if total_amount > 1000:
        print("You earned a discount!")

            

              
                Copy
              
            
          

2. استخراج فئة (Extract Class)

عندما يكون لفئة ما الكثير من المسؤوليات، استخرج بعضها إلى فئة جديدة. هذا يعزز مبدأ المسؤولية الواحدة.

مثال:

            
class Person:
    def __init__(self, name, phone_number, office_area_code, office_number):
        self.name = name
        self.phone_number = phone_number
        self.office_area_code = office_area_code
        self.office_number = office_number

    def get_name(self):
        return self.name

    def get_phone_number(self):
        return f"({self.office_area_code}) {self.office_number}"

            

              
                Copy
              
            
          

بعد إعادة الهيكلة:

            
class PhoneNumber:
    def __init__(self, area_code, number):
        self.area_code = area_code
        self.number = number

    def get_phone_number(self):
        return f"({self.area_code}) {self.number}"


class Person:
    def __init__(self, name, phone_number):
        self.name = name
        self.phone_number = phone_number

    def get_name(self):
        return self.name


            

              
                Copy
              
            
          

3. تضمين طريقة/دالة (Inline Method/Function)

هذا هو عكس استخراج الطريقة. إذا كان جسم الطريقة واضحًا مثل اسمها، يمكنك تضمين الطريقة عن طريق استبدال الاستدعاءات للطريقة بمحتوى الطريقة.

مثال:

            
def get_rating(driver):
    return more_than_five_late_deliveries(driver) ? 2 : 1


def more_than_five_late_deliveries(driver):
    return driver.number_of_late_deliveries > 5

            

              
                Copy
              
            
          

بعد إعادة الهيكلة:

            
def get_rating(driver):
    return driver.number_of_late_deliveries > 5 ? 2 : 1

            

              
                Copy
              
            
          

4. استبدال المتغير المؤقت باستعلام (Replace Temp with Query)

بدلاً من استخدام متغير مؤقت للاحتفاظ بنتيجة تعبير ما، استخرج التعبير إلى طريقة. هذا يتجنب تكرار الشيفرة ويعزز قابلية القراءة بشكل أفضل.

مثال:

            
def get_price(order):
    base_price = order.quantity * order.item_price
    discount_factor = 0.98 if base_price > 1000 else 0.95
    return base_price * discount_factor

            

              
                Copy
              
            
          

بعد إعادة الهيكلة:

            
def get_price(order):
    return base_price(order) * discount_factor(order)


def base_price(order):
    return order.quantity * order.item_price


def discount_factor(order):
    return 0.98 if base_price(order) > 1000 else 0.95

            

              
                Copy
              
            
          

5. تقديم كائن المعلمة (Introduce Parameter Object)

إذا كان لديك قائمة طويلة من المعلمات التي تظهر معًا بشكل متكرر، ففكر في إنشاء كائن معلمة لتغليفها. هذا يقلل من طول قائمة المعلمات ويحسن تنظيم الشيفرة.

مثال:

            
def calculate_total(width, height, depth, weight, shipping_method):
    # Calculation logic
    pass

            

              
                Copy
              
            
          

بعد إعادة الهيكلة:

            
class ShippingDetails:
    def __init__(self, width, height, depth, weight, shipping_method):
        self.width = width
        self.height = height
        self.depth = depth
        self.weight = weight
        self.shipping_method = shipping_method


def calculate_total(shipping_details):
    # Calculation logic using shipping_details attributes
    pass

            

              
                Copy